Modify settings for an existing connector on a node

Request

Applies to appliances and agents. Requires V2 connector config.

Requires node::configure::connectors permissions

Security

JWTAuthorizer

Path

nodeIDstringrequired

Node ID

connectorIDstringrequired

Connector ID

Bodyapplication/jsonrequired

Connector

descriptionstring

connector description

Example:"My connector"

enabledboolean

whether connector is enabled

Example:true

indexnumber

Sorting index for the connector

Example:1

localIpstring

local IP address

Example:"100.100.64.1"

maxmbpsnumber

maximum bandwidth in Mbps

Example:100

nicstring

network interface name

Example:"eth0"

nodestringrequired

node name

Example:"node1"

portnumberrequired

connector port

Example:1234

protocolstringrequired

connector protocol

Enum:"udp""tcp""tftp""ftp"

Example:"tcp"

servicestringrequired

service name

Example:"ssh"

sourceBlockstring

if provided, only traffic from this CIDR block will be allowed

curl -i -X PUT \
  'https://apidocs.trustgrid.io/_mock/v2/node/{nodeID}/config/connectors/{connectorID}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "My connector",
    "enabled": true,
    "localIp": "100.100.64.1",
    "maxmbps": 100,
    "nic": "eth0",
    "node": "node1",
    "port": 1234,
    "index": 1,
    "protocol": "tcp",
    "service": "ssh"
  }'

Responses

OK

Response

No content